主题
日志模块总览 - Overview
本分类做什么
可配置文件日志:路径、格式、级别、轮转、颜色、异步、多实例;以及 控制台 与 OpenConsole/CloseConsole 联动。写日志接口分 Trace~Critical 及 Ex 变体(附加字段见各页)。
一、生命周期与全局配置
| 接口 | 差异 |
|---|---|
| LogShutdown | 全局 关闭。 |
LogCreateInstance、LogDestroyInstance | 多实例 日志器(多模块分文件)。 |
LogSetFilePath、LogSetPattern、LogSetLevel、LogGetLevel | 文件、格式模式、级别。 |
LogSetTarget | 输出到 文件/控制台/二者。 |
LogSetAsync、LogSetFlushInterval | 异步 与 刷盘间隔。 |
二、文件与目录策略
| 接口 | 用途 |
|---|---|
LogSetMaxFileSize、LogSetMaxFiles | 单文件上限 与 保留个数(轮转)。 |
LogSetBaseDirectory、LogSetDirMode、LogSetFileNamePattern | 目录结构 与 文件名模式。 |
LogSetRotationMode、LogSetAppendMode | 切分策略、追加/覆盖。 |
LogRotateFile、LogCleanupOldFiles | 手动切分、清理历史。 |
差异:Pattern 决定 行格式;DirMode 决定 按日期/模块分子目录(见详情页)。
三、控制台与颜色
| 接口 | 说明 |
|---|---|
| OpenConsole、CloseConsole | 与 设置 中控制台说明一致时,二选一 避免重复打开。 |
LogSetColorMode、LogSetLevelColor、LogResetLevelColors | 控制台颜色 与 级别着色。 |
四、写入接口:普通 vs Ex
| 级别 | 普通 | Ex |
|---|---|---|
| Trace~Critical | LogTrace … LogCritical | LogTraceEx … LogCriticalEx |
差异:Ex 通常多 源文件/行号/附加字段 等(见详情页)。
五、查询
| 接口 | 用途 |
|---|---|
LogGetCurrentFilePath、LogGetCurrentFileSize、LogGetTotalFilesCount | 当前文件与 历史文件数。 |
六、快速选型
| 需求 | 建议 |
|---|---|
| 多 DLL 分日志 | LogCreateInstance |
| 按天切分 | LogSetRotationMode + LogSetFileNamePattern |
| 高性能 | LogSetAsync + 合理 FlushInterval |
七、注意
- 多线程 写日志是否完全无锁以版本为准。
- 敏感数据 勿打明文密码。
